/* ===========================================================
 * JFreeChart : a free chart library for the Java(tm) platform
 * ===========================================================
 *
 * (C) Copyright 2000-2008, by Object Refinery Limited and Contributors.
 *
 * Project Info:  http://www.jfree.org/jfreechart/index.html
 *
 * This library is free software; you can redistribute it and/or modify it
 * under the terms of the GNU Lesser General Public License as published by
 * the Free Software Foundation; either version 2.1 of the License, or
 * (at your option) any later version.
 *
 * This library is distributed in the hope that it will be useful, but
 * WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY
 * or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public
 * License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public
 * License along with this library; if not, write to the Free Software
 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301,
 * USA.
 *
 * [Java is a trademark or registered trademark of Sun Microsystems, Inc.
 * in the United States and other countries.]
 *
 * ---------------------
 * ChartChangeEvent.java
 * ---------------------
 * (C) Copyright 2000-2008, by Object Refinery Limited.
 *
 * Original Author:  David Gilbert (for Object Refinery Limited);
 * Contributor(s):   -;
 *
 * Changes (from 24-Aug-2001)
 * --------------------------
 * 24-Aug-2001 : Added standard source header. Fixed DOS encoding problem (DG);
 * 07-Nov-2001 : Updated header (DG);
 *               Change event type names (DG);
 * 09-Oct-2002 : Fixed errors reported by Checkstyle (DG);
 * 18-Feb-2005 : Changed the type from int to ChartChangeEventType (DG);
 *
 */

package org.jfree.chart.event;

import java.awt.geom.Rectangle2D;
import java.util.EventObject;

import org.jfree.chart.JFreeChart;
import org.jfree.data.general.DatasetChangeEvent;

/**
 * A change event that encapsulates information about a change to a chart.
 */
public class ChartChangeEvent extends EventObject {

    /** The type of event. */
    private ChartChangeEventType type;

    /** The chart that generated the event. */
    private JFreeChart chart;
    
    // DA_SPECIFIC ---->
	/**
	 * The updated plot area in which values are changed or <code>null</code> in Java2D coordinates.
	 * 
	 * @see DatasetChangeEvent
	 */
	private Rectangle2D				changedArea2D;
	// ---->     

    /**
     * Creates a new chart change event.
     *
     * @param source  the source of the event (could be the chart, a title,
     *                an axis etc.)
     */
    public ChartChangeEvent(Object source) {
    	// DA_SPECIFIC ---->
		this(source, null, ChartChangeEventType.GENERAL, null);
		// ---->
    }
    
    // DA_SPECIFIC ---->
	/**
	 * Creates a new chart change event.
	 * 
	 * @param source the source of the event (could be the chart, a title, an axis etc.)
	 * @param changedArea2D the changed area in Java2D coordinates.
	 */
	public ChartChangeEvent(Object source, Rectangle2D changedArea2D) {
		this(source, null, ChartChangeEventType.GENERAL, changedArea2D);
	}
	// ---->

    /**
     * Creates a new chart change event.
     *
     * @param source  the source of the event (could be the chart, a title, an
     *                axis etc.)
     * @param chart  the chart that generated the event.
     */
    public ChartChangeEvent(Object source, JFreeChart chart) {
    	// DA_SPECIFIC ---->
		this(source, chart, ChartChangeEventType.GENERAL, null);
		// ---->
    }

    /**
     * Creates a new chart change event.
     *
     * @param source  the source of the event (could be the chart, a title, an
                      axis etc.)
     * @param chart  the chart that generated the event.
     * @param type  the type of event.
     */
    public ChartChangeEvent(Object source, JFreeChart chart,
                            ChartChangeEventType type) {
    	// DA_SPECIFIC ---->
		this(source, chart, type, null);
		// ---->
	}

	// DA_SPECIFIC ---->
	/**
	 * Creates a new chart change event.
	 * 
	 * @param source the source of the event (could be the chart, a title, an axis etc.)
	 * @param chart the chart that generated the event.
	 * @param type the type of event.
	 * @param changedArea2D the changed area in Java2D coordinates.
	 */
	public ChartChangeEvent(Object source, JFreeChart chart, ChartChangeEventType type, Rectangle2D changedArea2D) {
        super(source);
        this.chart = chart;
        this.type = type;
        setChangedArea2D(changedArea2D);
	}
	// ---->

    /**
     * Returns the chart that generated the change event.
     *
     * @return The chart that generated the change event.
     */
    public JFreeChart getChart() {
        return this.chart;
    }

    /**
     * Sets the chart that generated the change event.
     *
     * @param chart  the chart that generated the event.
     */
    public void setChart(JFreeChart chart) {
        this.chart = chart;
    }

    /**
     * Returns the event type.
     *
     * @return The event type.
     */
    public ChartChangeEventType getType() {
        return this.type;
    }

    /**
     * Sets the event type.
     *
     * @param type  the event type.
     */
    public void setType(ChartChangeEventType type) {
        this.type = type;
    }
    
    // DA_SPECIFIC ---->
	/**
	 * Set changed area.
	 * 
	 * @param changedArea2D the changed area in Java2D coordinates or <code>null</code>.
	 */
	public void setChangedArea2D(Rectangle2D changedArea2D) {
		if (changedArea2D != null) {
			if (this.changedArea2D == null) {
				this.changedArea2D = new Rectangle2D.Double();
			}
			this.changedArea2D.setRect(changedArea2D);
		}
		else {
			this.changedArea2D = null;
		}
	}
	// ---->

	// DA_SPECIFIC ---->
	/**
	 * Return the area in which values are changed in Java2D coordinates or <code>null</code>.
	 * 
	 * @return the area in which values are changed in Java2D coordinates or <code>null</code>.
	 */
	public Rectangle2D getChangedArea2D() {
		return this.changedArea2D;
	}
	// ---->

}
